<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="de_DE" lang="de_DE">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>LineBasedFrameDecoder xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../api/org/jboss/netty/handler/codec/frame/LineBasedFrameDecoder.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright 2012 The Netty Project</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * The Netty Project licenses this file to you under the Apache License,</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * version 2.0 (the "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * with the License. You may obtain a copy of the License at:</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * License for the specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> org.jboss.netty.handler.codec.frame;
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.buffer.ChannelBuffer;
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.Channel;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.Channels;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> org.jboss.netty.channel.ChannelHandlerContext;
<a class="jxr_linenumber" name="22" href="#22">22</a>  
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * A decoder that splits the received {@link ChannelBuffer}s on line endings.</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * Both {@code "\n"} and {@code "\r\n"} are handled.</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * For a more general delimiter-based decoder, see {@link DelimiterBasedFrameDecoder}.</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/jboss/netty/handler/codec/frame/LineBasedFrameDecoder.html">LineBasedFrameDecoder</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/jboss/netty/handler/codec/frame/FrameDecoder.html">FrameDecoder</a> {
<a class="jxr_linenumber" name="30" href="#30">30</a>  
<a class="jxr_linenumber" name="31" href="#31">31</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Maximum length of a frame we're willing to decode.  */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxLength;
<a class="jxr_linenumber" name="33" href="#33">33</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Whether or not to throw an exception as soon as we exceed maxLength. */</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> failFast;
<a class="jxr_linenumber" name="35" href="#35">35</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stripDelimiter;
<a class="jxr_linenumber" name="36" href="#36">36</a>  
<a class="jxr_linenumber" name="37" href="#37">37</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> True if we're discarding input because we're already over maxLength.  */</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> discarding;
<a class="jxr_linenumber" name="39" href="#39">39</a>  
<a class="jxr_linenumber" name="40" href="#40">40</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">     * Creates a new decoder.</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">     * @param maxLength  the maximum length of the decoded frame.</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">     *                   A {@link TooLongFrameException} is thrown if</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">     *                   the length of the frame exceeds this value.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/jboss/netty/handler/codec/frame/LineBasedFrameDecoder.html">LineBasedFrameDecoder</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxLength) {
<a class="jxr_linenumber" name="47" href="#47">47</a>          <strong class="jxr_keyword">this</strong>(maxLength, <strong class="jxr_keyword">true</strong>, false);
<a class="jxr_linenumber" name="48" href="#48">48</a>      }
<a class="jxr_linenumber" name="49" href="#49">49</a>  
<a class="jxr_linenumber" name="50" href="#50">50</a>      <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment">     * Creates a new decoder.</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">     * @param maxLength  the maximum length of the decoded frame.</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">     *                   A {@link TooLongFrameException} is thrown if</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">     *                   the length of the frame exceeds this value.</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">     * @param stripDelimiter  whether the decoded frame should strip out the</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">     *                        delimiter or not</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">     * @param failFast  If &lt;tt&gt;true&lt;/tt&gt;, a {@link TooLongFrameException} is</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">     *                  thrown as soon as the decoder notices the length of the</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">     *                  frame will exceed &lt;tt&gt;maxFrameLength&lt;/tt&gt; regardless of</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">     *                  whether the entire frame has been read.</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">     *                  If &lt;tt&gt;false&lt;/tt&gt;, a {@link TooLongFrameException} is</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment">     *                  thrown after the entire frame that exceeds</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment">     *                  &lt;tt&gt;maxFrameLength&lt;/tt&gt; has been read.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>      <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/jboss/netty/handler/codec/frame/LineBasedFrameDecoder.html">LineBasedFrameDecoder</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> maxLength, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> stripDelimiter, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> failFast) {
<a class="jxr_linenumber" name="66" href="#66">66</a>          <strong class="jxr_keyword">this</strong>.maxLength = maxLength;
<a class="jxr_linenumber" name="67" href="#67">67</a>          <strong class="jxr_keyword">this</strong>.failFast = failFast;
<a class="jxr_linenumber" name="68" href="#68">68</a>          <strong class="jxr_keyword">this</strong>.stripDelimiter = stripDelimiter;
<a class="jxr_linenumber" name="69" href="#69">69</a>      }
<a class="jxr_linenumber" name="70" href="#70">70</a>  
<a class="jxr_linenumber" name="71" href="#71">71</a>      @Override
<a class="jxr_linenumber" name="72" href="#72">72</a>      <strong class="jxr_keyword">protected</strong> Object decode(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/channel/ChannelHandlerContext.html">ChannelHandlerContext</a> ctx,
<a class="jxr_linenumber" name="73" href="#73">73</a>                              <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/channel/Channel.html">Channel</a> channel,
<a class="jxr_linenumber" name="74" href="#74">74</a>                              <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/buffer/ChannelBuffer.html">ChannelBuffer</a> buffer) <strong class="jxr_keyword">throws</strong> Exception {
<a class="jxr_linenumber" name="75" href="#75">75</a>          <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> eol = findEndOfLine(buffer);
<a class="jxr_linenumber" name="76" href="#76">76</a>          <strong class="jxr_keyword">if</strong> (eol != -1) {
<a class="jxr_linenumber" name="77" href="#77">77</a>              <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/buffer/ChannelBuffer.html">ChannelBuffer</a> frame;
<a class="jxr_linenumber" name="78" href="#78">78</a>              <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length = eol - buffer.readerIndex();
<a class="jxr_linenumber" name="79" href="#79">79</a>              assert length &gt;= 0: <span class="jxr_string">"Invalid length="</span> + length;
<a class="jxr_linenumber" name="80" href="#80">80</a>              <strong class="jxr_keyword">if</strong> (discarding) {
<a class="jxr_linenumber" name="81" href="#81">81</a>                  frame = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="82" href="#82">82</a>                  buffer.skipBytes(length);
<a class="jxr_linenumber" name="83" href="#83">83</a>                  <strong class="jxr_keyword">if</strong> (!failFast) {
<a class="jxr_linenumber" name="84" href="#84">84</a>                      fail(ctx, <span class="jxr_string">"over "</span> + (maxLength + length) + <span class="jxr_string">" bytes"</span>);
<a class="jxr_linenumber" name="85" href="#85">85</a>                  }
<a class="jxr_linenumber" name="86" href="#86">86</a>              } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="87" href="#87">87</a>                  <strong class="jxr_keyword">int</strong> delimLength;
<a class="jxr_linenumber" name="88" href="#88">88</a>                  <strong class="jxr_keyword">final</strong> byte delim = buffer.getByte(buffer.readerIndex() + length);
<a class="jxr_linenumber" name="89" href="#89">89</a>                  <strong class="jxr_keyword">if</strong> (delim == '\r') {
<a class="jxr_linenumber" name="90" href="#90">90</a>                      delimLength = 2;  <em class="jxr_comment">// Skip the \r\n.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>                  } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="92" href="#92">92</a>                      delimLength = 1;
<a class="jxr_linenumber" name="93" href="#93">93</a>                  }
<a class="jxr_linenumber" name="94" href="#94">94</a>                  <strong class="jxr_keyword">if</strong> (stripDelimiter) {
<a class="jxr_linenumber" name="95" href="#95">95</a>                      frame = extractFrame(buffer, buffer.readerIndex(), length);
<a class="jxr_linenumber" name="96" href="#96">96</a>                  } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="97" href="#97">97</a>                      frame = extractFrame(buffer, buffer.readerIndex(), length + delimLength);
<a class="jxr_linenumber" name="98" href="#98">98</a>                  }
<a class="jxr_linenumber" name="99" href="#99">99</a>                  buffer.skipBytes(length + delimLength);
<a class="jxr_linenumber" name="100" href="#100">100</a>             }
<a class="jxr_linenumber" name="101" href="#101">101</a>             <strong class="jxr_keyword">return</strong> frame;
<a class="jxr_linenumber" name="102" href="#102">102</a>         }
<a class="jxr_linenumber" name="103" href="#103">103</a> 
<a class="jxr_linenumber" name="104" href="#104">104</a>         <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> buffered = buffer.readableBytes();
<a class="jxr_linenumber" name="105" href="#105">105</a>         <strong class="jxr_keyword">if</strong> (!discarding &amp;&amp; buffered &gt; maxLength) {
<a class="jxr_linenumber" name="106" href="#106">106</a>             discarding = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="107" href="#107">107</a>             <strong class="jxr_keyword">if</strong> (failFast) {
<a class="jxr_linenumber" name="108" href="#108">108</a>                 fail(ctx, buffered + <span class="jxr_string">" bytes buffered already"</span>);
<a class="jxr_linenumber" name="109" href="#109">109</a>             }
<a class="jxr_linenumber" name="110" href="#110">110</a>         }
<a class="jxr_linenumber" name="111" href="#111">111</a>         <strong class="jxr_keyword">if</strong> (discarding) {
<a class="jxr_linenumber" name="112" href="#112">112</a>             buffer.skipBytes(buffer.readableBytes());
<a class="jxr_linenumber" name="113" href="#113">113</a>         }
<a class="jxr_linenumber" name="114" href="#114">114</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="115" href="#115">115</a>     }
<a class="jxr_linenumber" name="116" href="#116">116</a> 
<a class="jxr_linenumber" name="117" href="#117">117</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> fail(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/channel/ChannelHandlerContext.html">ChannelHandlerContext</a> ctx, <strong class="jxr_keyword">final</strong> String msg) {
<a class="jxr_linenumber" name="118" href="#118">118</a>         Channels.fireExceptionCaught(ctx.getChannel(),
<a class="jxr_linenumber" name="119" href="#119">119</a>             <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/jboss/netty/handler/codec/frame/TooLongFrameException.html">TooLongFrameException</a>(<span class="jxr_string">"Frame length exceeds "</span> + maxLength + <span class="jxr_string">" ("</span>
<a class="jxr_linenumber" name="120" href="#120">120</a>                                       + msg + ')'));
<a class="jxr_linenumber" name="121" href="#121">121</a>     }
<a class="jxr_linenumber" name="122" href="#122">122</a> 
<a class="jxr_linenumber" name="123" href="#123">123</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">     * Returns the index in the buffer of the end of line found.</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">     * Returns -1 if no end of line was found in the buffer.</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="127" href="#127">127</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> findEndOfLine(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/jboss/netty/buffer/ChannelBuffer.html">ChannelBuffer</a> buffer) {
<a class="jxr_linenumber" name="128" href="#128">128</a>         <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> n = buffer.writerIndex();
<a class="jxr_linenumber" name="129" href="#129">129</a>         <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = buffer.readerIndex(); i &lt; n; i ++) {
<a class="jxr_linenumber" name="130" href="#130">130</a>             <strong class="jxr_keyword">final</strong> byte b = buffer.getByte(i);
<a class="jxr_linenumber" name="131" href="#131">131</a>             <strong class="jxr_keyword">if</strong> (b == '\n') {
<a class="jxr_linenumber" name="132" href="#132">132</a>                 <strong class="jxr_keyword">return</strong> i;
<a class="jxr_linenumber" name="133" href="#133">133</a>             } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (b == '\r' &amp;&amp; i &lt; n - 1 &amp;&amp; buffer.getByte(i + 1) == '\n') {
<a class="jxr_linenumber" name="134" href="#134">134</a>                 <strong class="jxr_keyword">return</strong> i;  <em class="jxr_comment">// \r\n</em>
<a class="jxr_linenumber" name="135" href="#135">135</a>             }
<a class="jxr_linenumber" name="136" href="#136">136</a>         }
<a class="jxr_linenumber" name="137" href="#137">137</a>         <strong class="jxr_keyword">return</strong> -1;  <em class="jxr_comment">// Not found.</em>
<a class="jxr_linenumber" name="138" href="#138">138</a>     }
<a class="jxr_linenumber" name="139" href="#139">139</a> 
<a class="jxr_linenumber" name="140" href="#140">140</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

